| useWalletClient | 您所在的位置：网站首页 › wagmibros › useWalletClient |
|
useWalletClient Hook for getting a Viem WalletClient object for the current or provided connector. Import tsimport { useWalletClient } from 'wagmi'Usage tsximport { useWalletClient } from 'wagmi' function App() { const result = useWalletClient() }tsimport { http, createConfig } from 'wagmi' import { mainnet, sepolia } from 'wagmi/chains' export const config = createConfig({ chains: [mainnet, sepolia], transports: { [mainnet.id]: http(), [sepolia.id]: http(), }, })WARNING If you want to optimize bundle size, you should use useConnectorClient along with Viem's tree-shakable actions instead. Since Wallet Client has all wallet actions attached directly to it. Parameters tsimport { type UseWalletClientParameters } from 'wagmi'account Address | Account | undefined Account to use with client. Throws if account is not found on connector. tsimport { useWalletClient } from 'wagmi' function App() { const result = useWalletClient({ account: '0xd2135CfB216b74109775236E36d4b433F1DF507B', }) }chainId config['chains'][number]['id'] | undefined ID of chain to use with client. tsimport { useWalletClient } from 'wagmi' function App() { const result = useWalletClient({ chainId: mainnet.id, }) }config Config | undefined Config to use instead of retrieving from the from nearest WagmiProvider. tsximport { useWalletClient } from 'wagmi' import { config } from './config' function App() { const result = useWalletClient({ config, }) }tsimport { http, createConfig } from 'wagmi' import { mainnet, sepolia } from 'wagmi/chains' export const config = createConfig({ chains: [mainnet, sepolia], transports: { [mainnet.id]: http(), [sepolia.id]: http(), }, })connector Connector | undefined Connector to get client for.Defaults to current connector.tsimport { useConnections, useWalletClient } from 'wagmi' function App() { const connections = useConnections(config) const result = useWalletClient({ connector: connections[0]?.connector, }) }query TanStack Query parameters. See the TanStack Query query docs for more info. Wagmi does not support passing all TanStack Query parameters TanStack Query parameters, like queryFn and queryKey, are used internally to make Wagmi work and you cannot override them. Check out the source to see what parameters are not supported. All parameters listed below are supported. enabled boolean | undefined Set this to false to disable this query from automatically running.Can be used for Dependent Queries.initialData WalletClient | (() => WalletClient) | undefined If set, this value will be used as the initial data for the query cache (as long as the query hasn't been created or cached yet)If set to a function, the function will be called once during the shared/root query initialization, and be expected to synchronously return the initialDataInitial data is considered stale by default unless a staleTime has been set.initialData is persisted to the cacheinitialDataUpdatedAt number | ((() => number | undefined)) | undefined If set, this value will be used as the time (in milliseconds) of when the initialData itself was last updated. meta Record | undefined If set, stores additional information on the query cache entry that can be used as needed. It will be accessible wherever the query is available, and is also part of the QueryFunctionContext provided to the queryFn. networkMode online' | 'always' | 'offlineFirst' | undefined Defaults to 'online'see Network Mode for more information.notifyOnChangeProps string[] | 'all' | (() => string[] | 'all') | undefined If set, the component will only re-render if any of the listed properties change.If set to ['data', 'error'] for example, the component will only re-render when the data or error properties change.If set to 'all', the component will opt-out of smart tracking and re-render whenever a query is updated.If set to a function, the function will be executed to compute the list of properties.By default, access to properties will be tracked, and the component will only re-render when one of the tracked properties change.placeholderData WalletClient | ((previousValue: WalletClient | undefined; previousQuery: Query | undefined) => WalletClient) | undefined If set, this value will be used as the placeholder data for this particular query observer while the query is still in the pending state.placeholderData is not persisted to the cacheIf you provide a function for placeholderData, as a first argument you will receive previously watched query data if available, and the second argument will be the complete previousQuery instance.queryClient QueryClient | undefined Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used. refetchInterval number | false | ((data: WalletClient | undefined, query: Query) => number | false | undefined) | undefined If set to a number, all queries will continuously refetch at this frequency in millisecondsIf set to a function, the function will be executed with the latest data and query to compute a frequencyrefetchIntervalInBackground boolean | undefined If set to true, queries that are set to continuously refetch with a refetchInterval will continue to refetch while their tab/window is in the background refetchOnMount boolean | 'always' | ((query: Query) => boolean | 'always') | undefined Defaults to trueIf set to true, the query will refetch on mount if the data is stale.If set to false, the query will not refetch on mount.If set to 'always', the query will always refetch on mount.If set to a function, the function will be executed with the query to compute the valuerefetchOnReconnect boolean | 'always' | ((query: Query) => boolean | 'always') | undefined Defaults to trueIf set to true, the query will refetch on reconnect if the data is stale.If set to false, the query will not refetch on reconnect.If set to 'always', the query will always refetch on reconnect.If set to a function, the function will be executed with the query to compute the valuerefetchOnWindowFocus boolean | 'always' | ((query: Query) => boolean | 'always') | undefined Defaults to trueIf set to true, the query will refetch on window focus if the data is stale.If set to false, the query will not refetch on window focus.If set to 'always', the query will always refetch on window focus.If set to a function, the function will be executed with the query to compute the valueretry boolean | number | ((failureCount: number, error: GetWalletClientErrorType) => boolean) | undefined If false, failed queries will not retry by default.If true, failed queries will retry infinitely.If set to a number, e.g. 3, failed queries will retry until the failed query count meets that number.Defaults to 3 on the client and 0 on the serverretryDelay number | ((retryAttempt: number, error: GetWalletClientErrorType) => number) | undefined This function receives a retryAttempt integer and the actual Error and returns the delay to apply before the next attempt in milliseconds.A function like attempt => Math.min(attempt > 1 ? 2 ** attempt * 1000 : 1000, 30 * 1000) applies exponential backoff.A function like attempt => attempt * 1000 applies linear backoff.retryOnMount boolean | undefined If set to false, the query will not be retried on mount if it contains an error. Defaults to true. select ((data: WalletClient) => unknown) | undefined This option can be used to transform or select a part of the data returned by the query function. It affects the returned data value, but does not affect what gets stored in the query cache. structuralSharing boolean | (((oldData: WalletClient | undefined, newData: WalletClient) => WalletClient)) | undefined Defaults to trueIf set to false, structural sharing between query results will be disabled.If set to a function, the old and new data values will be passed through this function, which should combine them into resolved data for the query. This way, you can retain references from the old data to improve performance even when that data contains non-serializable values.Return Type tsimport { type UseWalletClientReturnType } from 'wagmi'TanStack Query query docs data WalletClient The last successfully resolved data for the query.Defaults to undefined.dataUpdatedAt number The timestamp for when the query most recently returned the status as 'success'. error null | GetWalletClientErrorType The error object for the query, if an error was thrown.Defaults to nullerrorUpdatedAt number The timestamp for when the query most recently returned the status as 'error'. errorUpdateCount number The sum of all errors. failureCount number The failure count for the query.Incremented every time the query fails.Reset to 0 when the query succeeds.failureReason null | GetWalletClientErrorType The failure reason for the query retry.Reset to null when the query succeeds.fetchStatus 'fetching' | 'idle' | 'paused' fetching Is true whenever the queryFn is executing, which includes initial pending as well as background refetches.paused The query wanted to fetch, but has been paused.idle The query is not fetching.See Network Mode for more information.isError / isPending / isSuccess boolean Boolean variables derived from status. isFetched boolean Will be true if the query has been fetched. isFetchedAfterMount boolean Will be true if the query has been fetched after the component mounted.This property can be used to not show any previously cached data.isFetching / isPaused boolean Boolean variables derived from fetchStatus. isLoading boolean Is true whenever the first fetch for a query is in-flightIs the same as isFetching && isPendingisLoadingError boolean Will be true if the query failed while fetching for the first time. isPlaceholderData boolean Will be true if the data shown is the placeholder data. isRefetchError boolean Will be true if the query failed while refetching. isRefetching boolean Is true whenever a background refetch is in-flight, which does not include initial 'pending'.Is the same as isFetching && !isPendingisStale boolean Will be true if the data in the cache is invalidated or if the data is older than the given staleTime. refetch (options: { cancelRefetch?: boolean | undefined; throwOnError?: boolean | undefined }) => Promise A function to manually refetch the query.throwOnErrorWhen set to true, an error will be thrown if the query fails.When set to false, an error will be logged if the query fails.cancelRefetchWhen set to true, a currently running request will be cancelled before a new request is made.When set to false, no refetch will be made if there is already a request running.Defaults to truestatus 'error' | 'pending' | 'success' pending if there's no cached data and no query attempt was finished yet.error if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetchsuccess if the query has received a response with no errors and is ready to display its data. The corresponding data property on the query is the data received from the successful fetch or if the query's enabled property is set to false and has not been fetched yet data is the first initialData supplied to the query on initialization.TanStack Query tsimport { type GetWalletClientData, type GetWalletClientOptions, type GetWalletClientQueryFnData, type GetWalletClientQueryKey, getWalletClientQueryKey, getWalletClientQueryOptions, } from 'wagmi/query'Action getWalletClient |
| CopyRight 2018-2019 实验室设备网 版权所有 |